Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: expanded svelte/reactivity documentation #14799

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: expanded svelte/reactivity documentation #14799

wants to merge 1 commit into from

Conversation

marekdedic
Copy link

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

This PR expands the documentation of svelte/reactivity based on #14376

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 21, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: cc5dc20

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14799-svelte.vercel.app/

this is an automated message

@marekdedic marekdedic force-pushed the reactivity-docs-upgrades branch from bdc61c7 to cc5dc20 Compare December 21, 2024 23:34
@marekdedic marekdedic requested a review from Leonidaz December 21, 2024 23:37
@Leonidaz Leonidaz mentioned this pull request Dec 22, 2024
Open
@marekdedic marekdedic force-pushed the reactivity-docs-upgrades branch from cc5dc20 to 1901237 Compare January 11, 2025 22:17
@marekdedic marekdedic mentioned this pull request Feb 3, 2025
Closed
@spykr
Copy link

spykr commented Feb 12, 2025

It would be great to get this merged. Using Maps in Svelte 5 is currently a confusing experience because there's no documentation, I had to track down this PR to understand how to use SvelteMap correctly. Specifically the differences between 1) new SvelteMap() and $state(new SvelteMap()) and 2) map.set(key, { value }) and map.set(key, $state({ value })) were not intuitive to me until I was able to find these docs and see it explained.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taitulism taitulism taitulism left review comments

@Leonidaz Leonidaz Awaiting requested review from Leonidaz

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@marekdedic @Rich-Harris @spykr @Leonidaz @taitulism